<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	<title></title>
	<style type="text/css">
	/* ZenDoc identity */
	.zendoc { font-family: Arial, Helvetica, sans-serif; margin:3px; }
	.zendoc a:hover { text-decoration:none; }
	.zendoc span.title-comment { font-family: Verdana, Arial, Helvetica, sans-serif; font-size:80%; color:#AAA; }
	.zendoc span.title-zen { color:#26A; font-weight:normal; }
	.zendoc span.title-doc { color:black; font-weight:bold; }
	/* overall */
	html, body, div { margin:0; padding:0; border:none; }
	body { font-family:Arial, Helvetica, sans-serif; font-size:90%; }
	a { text-decoration:none; }
	a:hover { text-decoration:underline; }
	h2 { color:#999; margin:2em 0 0 0; padding:0 2px 0 20px; border-bottom:2px solid #58B; }
	h3 { color:#B36B00; margin-top:3em; }
	dl { margin:.5em 0 3px 0; }
	dt { font-weight:bold; }
	td { vertical-align:top; }
	th { text-align:left; color:#58B; background-color:#E3ECF4; }
	code { font-size:1.1em; }
	/* specific */
	#header { background-color:#EAEAEA; padding:1px; }
	#links { color:#999; background-color:#FFE; border-bottom:1px solid #58B; padding:2px 20px; }
	#links a { color:#999; }
	.content { padding:10px 20px; }
	#class-definition { background-color:#58B; color:white; }
	#class-definition .classkind { font-weight:bold; }
	#class-definition .classkind .package { font-weight:normal; }
	#class-definition .classname { font-size:4em; margin:5px 0; }
	#class-definition .superclassname { padding-left:20px; font-style:italic; }
	#class-definition .implements { padding-left:20px; font-style:italic; }
	#class-info .content { margin:20px; border:1px solid #58B; }
	pre.definition { background-color:#FFE; border:1px solid #E4E29A; padding:3px; }
	.generated {
		font-style:italic;
		font-size:80%;
		color:#666;
		margin:1em 0 0 0;
		padding:5px 20px;
		border-top:1px solid #999;
	}
	/* tables */
	.member-list { border:1px solid #58B; margin:2em 20px; }
	.member-list a { color:#B36B00; }
	.member-list table { border-collapse:collapse; }
	.member-list td { border-top:1px solid #58B; }
	.member-list td.name { width:175px; text-align:right; padding-right:5px; }
	.member-list table { width:100%; }
	.even { background-color:#FFE; }
	.odd { background-color:white; }
	.param .name { color:#666; }
	</style>
</head>

<body>
<div id="page">
	<div id="header">
		<h4 class="zendoc"><a href="http://www.zendoc.org" title="ZenDoc Documentation Tool Home"><span class="title-comment">/**</span><span class="title-zen">Zen</span><span class="title-doc">Doc</span><span class="title-comment">--&gt;</span></a></h4>
	</div>
	<div id="class-definition" class="section">
		<div class="content">
			
			
			
		</div>
		<div id="links">
			<a href="#class-info">Class Information</a>
			
			 | <a href="#class-properties">Properties</a>
			 | <a href="#class-methods">Methods</a>
			
		</div>
	</div>
	
	<div id="class-info" class="section">
		<h2>Class Information</h2>
		<div class="content">
			
			<em>No Class Information Available</em>
			</div>
			
			
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Properties</th></tr>
				<tr class="even">
					<td class="name"><a href="#mcScroll">mcScroll</a></td>
					<td>The clip represents the scrollBar on the scene</td>
				</tr><tr class="odd">
					<td class="name"><a href="#maskScroll">maskScroll</a></td>
					<td>The clip represents the mask to apply on the content</td>
				</tr><tr class="even">
					<td class="name"><a href="#sizeToScroll">sizeToScroll</a></td>
					<td>The size of the visible zone of the content</td>
				</tr><tr class="odd">
					<td class="name"><a href="#contenu">contenu</a></td>
					<td>The content to scroll</td>
				</tr><tr class="even">
					<td class="name"><a href="#type">type</a></td>
					<td>The type of the scrollBar</td>
				</tr><tr class="odd">
					<td class="name"><a href="#marge">marge</a></td>
					<td>The marge between the scrollBar and the content. Use only if the scrollBar autoPosition is enable.</td>
				</tr><tr class="even">
					<td class="name"><a href="#rollOverScroll">rollOverScroll</a></td>
					<td>Enable or disable the rollOver action on the scrollUp and scrollDown buttons.</td>
				</tr><tr class="odd">
					<td class="name"><a href="#autoSizeBtn">autoSizeBtn</a></td>
					<td>Enable or disable the auto size of the scrollBar slider.</td>
				</tr><tr class="even">
					<td class="name"><a href="#scrollMouseMoveType">scrollMouseMoveType</a></td>
					<td>To set the scrollMoveType for the type <code>ScrollBarType.VERTICAL_MOUSEMOVE</code> and <code>ScrollBarType.HORIZONTAL_MOUSEMOVE</code>. Default <code>ScrollMouseMoveType.MOUSEMOVE_POSITION</code></td>
				</tr><tr class="odd">
					<td class="name"><a href="#vitesseScrollType2">vitesseScrollType2</a></td>
					<td>The speed of the scrollBar mouse move (use only for the types ScrollBarType.VERTICAL_MOUSEMOVE and ScrollBarType.HORIZONTAL_MOUSEMOVE</td>
				</tr><tr class="even">
					<td class="name"><a href="#valScrollMouseSide">valScrollMouseSide</a></td>
					<td>The speed of the scrollBar mouse move (use only for the types ScrollBarType.VERTICAL_MOUSEMOVE and ScrollBarType.HORIZONTAL_MOUSEMOVE</td>
				</tr><tr class="odd">
					<td class="name"><a href="#valScrollFleche">valScrollFleche</a></td>
					<td>The speed of the scrollBar buttons scrollUp and scrollDown action</td>
				</tr><tr class="even">
					<td class="name"><a href="#valScrollWheel">valScrollWheel</a></td>
					<td>The speed of the scrollBar mouseWheel action</td>
				</tr><tr class="odd">
					<td class="name"><a href="#sizeContenu">sizeContenu</a></td>
					<td>The size of the content to scroll</td>
				</tr><tr class="even">
					<td class="name"><a href="#listScrollWheelEnabled">listScrollWheelEnabled</a></td>
					<td>A array of <code>ScrollBar</code> which the mouseWheel is enabled. If the array is empty or not set, all the ScrollBar mouseWheel are enabled. If is not empty, only the <code>ScrollBars</code> in the array are their mouseWheel enabled</td>
				</tr><tr class="odd">
					<td class="name"><a href="#stage">stage</a></td>
					<td>To set the stage</td>
				</tr>
			</table></div>
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Methods</th></tr>
				<tr class="even">
					<td class="name"><a href="#ScrollBar">ScrollBar()</a></td>
					<td>Create an instance of ScrollBar.</td>
				</tr><tr class="odd">
					<td class="name"><a href="#create">create()</a></td>
					<td>Construct the scroll</td>
				</tr><tr class="even">
					<td class="name"><a href="#setSizeScrollBar">setSizeScrollBar()</a></td>
					<td>To force the size of the ScrollBar</td>
				</tr><tr class="odd">
					<td class="name"><a href="#init">init()</a></td>
					<td>Initilize the scrollBar. This method need to call every time the size of the content of the scroll changes.</td>
				</tr><tr class="even">
					<td class="name"><a href="#goTo">goTo()</a></td>
					<td>To go at the position in pixel of the content of the scrolBar</td>
				</tr><tr class="odd">
					<td class="name"><a href="#kill">kill()</a></td>
					<td>To kill the scroll. Remove mask and every listeners. It irreversible.</td>
				</tr><tr class="even">
					<td class="name"><a href="#removeListeners">removeListeners()</a></td>
					<td>To remove every listeners use by the scroll. You can recall the method init to re-initialize the scrollBar. The listeners will reset.</td>
				</tr><tr class="odd">
					<td class="name"><a href="#scrollIncrement">scrollIncrement()</a></td>
					<td>Increment the position of the scrollBar slider</td>
				</tr>
			</table></div>
			
			
	</div>
		
	
	<br />
	<div id="class-properties" class="member-group section">
		<h2>Properties</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="mcScroll">mcScroll</h3>
				<pre class="definition"><code>public function set mcScroll(val:MovieClip):void<br />public function get mcScroll():MovieClip</code></pre>
				<div>The clip represents the scrollBar on the scene</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="maskScroll">maskScroll</h3>
				<pre class="definition"><code>public function set maskScroll(val:DisplayObject):void<br />public function get maskScroll():DisplayObject</code></pre>
				<div>The clip represents the mask to apply on the content</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="sizeToScroll">sizeToScroll</h3>
				<pre class="definition"><code>public function set sizeToScroll(val:Number):void</code></pre>
				<div>The size of the visible zone of the content</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="contenu">contenu</h3>
				<pre class="definition"><code>public function set contenu(val:DisplayObject):void<br />public function get contenu():DisplayObject</code></pre>
				<div>The content to scroll</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="type">type</h3>
				<pre class="definition"><code>public function set type(val:int):void</code></pre>
				<div>The type of the scrollBar</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="marge">marge</h3>
				<pre class="definition"><code>public function set marge(val:Number):void</code></pre>
				<div>The marge between the scrollBar and the content. Use only if the scrollBar autoPosition is enable.</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="rollOverScroll">rollOverScroll</h3>
				<pre class="definition"><code>public function set rollOverScroll(val:Boolean):void</code></pre>
				<div>Enable or disable the rollOver action on the scrollUp and scrollDown buttons.</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="autoSizeBtn">autoSizeBtn</h3>
				<pre class="definition"><code>public function set autoSizeBtn(val:Boolean):void</code></pre>
				<div>Enable or disable the auto size of the scrollBar slider.</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="scrollMouseMoveType">scrollMouseMoveType</h3>
				<pre class="definition"><code>public function set scrollMouseMoveType(val:int):void</code></pre>
				<div>To set the scrollMoveType for the type <code>ScrollBarType.VERTICAL_MOUSEMOVE</code> and <code>ScrollBarType.HORIZONTAL_MOUSEMOVE</code>. Default <code>ScrollMouseMoveType.MOUSEMOVE_POSITION</code></div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="vitesseScrollType2">vitesseScrollType2</h3>
				<pre class="definition"><code>public function set vitesseScrollType2(val:Number):void</code></pre>
				<div>The speed of the scrollBar mouse move (use only for the types ScrollBarType.VERTICAL_MOUSEMOVE and ScrollBarType.HORIZONTAL_MOUSEMOVE</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="valScrollMouseSide">valScrollMouseSide</h3>
				<pre class="definition"><code>public function set valScrollMouseSide(val:Number):void</code></pre>
				<div>The speed of the scrollBar mouse move (use only for the types ScrollBarType.VERTICAL_MOUSEMOVE and ScrollBarType.HORIZONTAL_MOUSEMOVE</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="valScrollFleche">valScrollFleche</h3>
				<pre class="definition"><code>public function set valScrollFleche(val:Number):void</code></pre>
				<div>The speed of the scrollBar buttons scrollUp and scrollDown action</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="valScrollWheel">valScrollWheel</h3>
				<pre class="definition"><code>public function set valScrollWheel(val:Number):void</code></pre>
				<div>The speed of the scrollBar mouseWheel action</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="sizeContenu">sizeContenu</h3>
				<pre class="definition"><code>public function get sizeContenu():Number<br />public function set sizeContenu(value:Number):void</code></pre>
				<div>The size of the content to scroll</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="listScrollWheelEnabled">listScrollWheelEnabled</h3>
				<pre class="definition"><code>static public function get listScrollWheelEnabled():Array<br />static public function set listScrollWheelEnabled(value:Array):void</code></pre>
				<div>A array of <code>ScrollBar</code> which the mouseWheel is enabled. If the array is empty or not set, all the ScrollBar mouseWheel are enabled. If is not empty, only the <code>ScrollBars</code> in the array are their mouseWheel enabled</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="stage">stage</h3>
				<pre class="definition"><code>public function set stage(value:Stage):void</code></pre>
				<div>To set the stage</div>
				
			
			
			
			
			</div>
		</div>
	</div>
	<br />
	<div id="class-methods" class="member-group section">
		<h2>Methods</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="ScrollBar">ScrollBar()</h3>
				<pre class="definition"><code>function ScrollBar(clipScroll:MovieClip = null, contenu:DisplayObject = null , size:Number = 200, typeScroll:int = 1)</code></pre>
				<div>Create an instance of ScrollBar.</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>clipScroll</code></td><td>The clip represent the scrollbar on the scene (asset)</td></tr>
					<tr><td class="name"><code>contenu</code></td><td>The content to scroll. Default null</td></tr>
					<tr><td class="name"><code>size</code></td><td>The size of the content of the scroll visible in pixel. Default 200</td></tr>
					<tr><td class="name"><code>typeScroll</code></td><td>The type of the ScrollBar.(all types is defines in <code>ScrollBarType</code>). Default <code>ScrollBarType.VERTICAL</code></td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="create">create()</h3>
				<pre class="definition"><code>public function create(autoSize:Boolean = true, autoPosition:Boolean = true):void</code></pre>
				<div>Construct the scroll</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>autoSize</code></td><td>Enable or disable the autosize of the scrollbar elements (slider, slider backgrounds, etc...). Default true</td></tr>
					<tr><td class="name"><code>autoPosition</code></td><td>Enable or disable the auto position of elements of the scrollBar (buttons, etc..). Default true</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="setSizeScrollBar">setSizeScrollBar()</h3>
				<pre class="definition"><code>public function setSizeScrollBar(val:Number):void</code></pre>
				<div>To force the size of the ScrollBar</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>val</code></td><td>The size in pixel.</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="init">init()</h3>
				<pre class="definition"><code>public function init():void</code></pre>
				<div>Initilize the scrollBar. This method need to call every time the size of the content of the scroll changes.</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="goTo">goTo()</h3>
				<pre class="definition"><code>public function goTo(value:Number):void</code></pre>
				<div>To go at the position in pixel of the content of the scrolBar</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>value</code></td><td>The position in pixel of the content</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="kill">kill()</h3>
				<pre class="definition"><code>public function kill():void</code></pre>
				<div>To kill the scroll. Remove mask and every listeners. It irreversible.</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="removeListeners">removeListeners()</h3>
				<pre class="definition"><code>public function removeListeners():void</code></pre>
				<div>To remove every listeners use by the scroll. You can recall the method init to re-initialize the scrollBar. The listeners will reset.</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="scrollIncrement">scrollIncrement()</h3>
				<pre class="definition"><code>public function scrollIncrement(val:Number)</code></pre>
				<div>Increment the position of the scrollBar slider</div>
				<dl>
					<dt>Parameters:</dt>
					<dd><table class="param">
						<tr><td class="name"><code>val</code></td><td>Number in pixel</td></tr>
					</table></dd>
				</dl>
				
				
			
			
			
			
			</div>
		</div>
	</div>
	
	<p class="generated">Page generated: 12:25 pm on June 8, 2010</p>
</div>
</body>
</html>